home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / patchSG0004915.idb / usr / ToolTalk / man3 / tt_message_user.z / tt_message_user
Encoding:
Text File  |  2003-08-19  |  3.8 KB  |  66 lines
  1.  
  2.  
  3.  
  4. tttttttt____mmmmeeeessssssssaaaaggggeeee____uuuusssseeeerrrr((((3333))))                                          tttttttt____mmmmeeeessssssssaaaaggggeeee____uuuusssseeeerrrr((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      tt_message_user - retrieve the user information associated with a message
  10.      object
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<TTTTtttt////tttttttt____cccc....hhhh>>>>
  14.      vvvvooooiiiidddd ****tttttttt____mmmmeeeessssssssaaaaggggeeee____uuuusssseeeerrrr((((TTTTtttt____mmmmeeeessssssssaaaaggggeeee _m,,,,
  15.                            iiiinnnntttt _k_e_y))));;;;
  16.  
  17. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      The tttttttt____mmmmeeeessssssssaaaaggggeeee____uuuusssseeeerrrr() function retrieves the user information stored in
  19.      data cells associated with the specified message object.
  20.  
  21.      The user data is part of the message object (that is, the storage buffer
  22.      in the application); it is not a part of the actual message.  The
  23.      application can, therefore, only retrieve user information that the
  24.      application placed in the message.
  25.  
  26.      The _m argument is the opaque handle for the message involved in this
  27.      operation.  The _k_e_y argument is the user data cell to be retrieved.  The
  28.      user data cell must be unique for this message.
  29.  
  30. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  31.      Upon successful completion, the tttttttt____mmmmeeeessssssssaaaaggggeeee____uuuusssseeeerrrr() function returns the
  32.      data cell, a piece of arbitrary user data that can hold a vvvvooooiiiidddd ****.  The
  33.      application can use tttttttt____ppppttttrrrr____eeeerrrrrrrroooorrrr(3) to extract one of the following
  34.      TTTTtttt____ssssttttaaaattttuuuussss values from the returned data:
  35.  
  36.         TTTTTTTT____OOOOKKKK   The operation completed successfully.
  37.  
  38.         TTTTTTTT____EEEERRRRRRRR____NNNNOOOOMMMMPPPP
  39.                 The ttttttttsssseeeessssssssiiiioooonnnn(1) process is not running and the ToolTalk
  40.                 service cannot restart it.
  41.  
  42.         TTTTTTTT____EEEERRRRRRRR____PPPPOOOOIIIINNNNTTTTEEEERRRR
  43.                 The pointer passed does not point to an object of the correct
  44.                 type for this operation.
  45.  
  46. AAAAPPPPPPPPLLLLIIIICCCCAAAATTTTIIIIOOOONNNN UUUUSSSSAAAAGGGGEEEE
  47.      The application should use tttttttt____ffffrrrreeeeeeee(3) to free any data stored in the
  48.      address returned by the ToolTalk API.
  49.  
  50.      The user data cell is intended to hold an address.  If the address
  51.      selected is equal to one of the TTTTtttt____ssssttttaaaattttuuuussss enumerated values, the result
  52.      of the tttttttt____ppppttttrrrr____eeeerrrrrrrroooorrrr(3) function will not be reliable.
  53.  
  54. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  55.      TTTTtttttttttttt____cccc(5), tttttttt____ppppttttrrrr____eeeerrrrrrrroooorrrr(3), tttttttt____ffffrrrreeeeeeee(3).
  56.  
  57.  
  58.  
  60.  
  61.  
  62.                                                                         PPPPaaaaggggeeee 1111
  63.  
  64.  
  65.  
  66.